home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / qbbs / qbfbst10.zip / QBFBSTAT.DOC < prev    next >
Text File  |  1991-11-29  |  12KB  |  349 lines
  1.  
  2. ------------------------------------------------------------------------------
  3.                               QBFBStat v1.0
  4.  
  5.           QuickBBS File Areas Statistics Bulletin Generator
  6.  
  7.                  Copyright (C) 1990-91  Foxtrot Software
  8.                            All Rights Reserved.
  9.  
  10.   This is a shareware program, this program is not to be sold or modified
  11. in any way.  You are free to copy and distribute QBFBStat as long as:
  12.  
  13.   a.  No fee is charged for use of the program or the documentation.
  14.       A fee may be charged for copying or distibution of this software
  15.       and documentation for others not to exceed US$ 10.00.
  16.  
  17.   b.  It is not modified in any way.
  18.  
  19.   c.  You distribute this software along with all documentation and
  20.       registration forms unmodified.
  21.  
  22.  
  23.   The Author hereby disclaims all warranties relating to this software,
  24. whether expressed or implied, including without limitation any implied
  25. warranties of merchantability or fitness for a particular purpose.  The
  26. author will not be liable for any special, incidental, consequenctial,
  27. indirect or simular damages due to loss of data or any other reason.  The
  28. user of this software bears all risk as to the quality  and performance
  29. of this software.
  30.  
  31. -------------------Now that we have that out of the way-----------------------
  32.  
  33.   If you have any comments or suggestions for improvement of this software,
  34. you can contact me at Info-Center BBS, data: (914 )567-1814, 24 hours a
  35. day or leave Net-Mail @FIDO NET 1:272/26, @MagNet 100:900/39.
  36.  
  37.   If you like this software, and decide to keep it on your system and
  38. to use it, then you must register it.  You are entitled to use QBFBStat
  39. for a trial period of 30 days.   QBFBSTat Registration fee is US$8.00. 
  40. New York residents please add 6.5% sales tax to the registration fee.
  41.  
  42.   When registered, you will receive an QBFBStat key for your system.
  43. The KEY you receive will enable the -F option to allow multiple
  44. bulletins to be created.
  45.  
  46.                        Thank you for your support!
  47.  
  48. ------------------------------------------------------------------------------
  49.  
  50. 1. Introduction.
  51.  
  52.    QBFBStat is a utility that will allow the Sysop of a QuickBBS BBS
  53.    to produce a Files Area Statistic Report that features the following:
  54.  
  55.    a.  Total files in all selected areas.
  56.    b.  Total bytes in all selected areas.
  57.    c.  Total files for each area selected.
  58.    d.  Total bytes for each area selected.
  59.    e.  Percentage of the total files that each area contains.
  60.    f.  Ascii and Ansi Bulletins.
  61.    g.  Multiple bulletins.
  62.    h.  Full File Area Security Level/Security Flag Checking.
  63.  
  64.  
  65.    QBFBStat uses the environment variable QUICK to find the system files
  66. for your QuickBBS BBS system.  If you don't have this variable set then 
  67. QBFBStat will try to find the FILECFG.DAT, QUICKCFG.DAT files in the current 
  68. directory.   Selected areas are determined by using Security and Flags settings
  69. configured in the QBFBSTAT.CTL file.  The Security and Flags used are the
  70. same as that are used in FILECFG.DAT.  Areas that don't match the criteria
  71. specified will not be processed.
  72.  
  73.    QBFBStat allows you to create multiple bulletins by specifying the
  74. -F option at startup.  You can have a different QBFBSTAT.CTL file
  75. that may contain different file area specifications.
  76.  
  77.  
  78. 2.  Files needed by QBFBStat:
  79.  
  80.        INPUT:
  81.  
  82.          QUICKCFG.DAT   -   QuickBBS BBS Configuration File.
  83.          FILECFG.DAT    -   File Areas Configuration.
  84.          QBFBSTAT.CTL   -  Control file for QBFBSTAT.  Or any .CTL file
  85.                            that is defined on the command line when executed.
  86.  
  87.        OUTPUT:
  88.  
  89.          BULLETIN.ANS
  90.          BULLETIN.ASC -  A bulletin file that you will specify in
  91.                          QBFBSTAT.CTL file.  Actually two files will
  92.                          be created as output.  One is a plain ascii
  93.                          file, the other will contain ansi screen
  94.                          commands for color.  When specifying the
  95.                          filenames, DO NOT append .ASC or .ANS.
  96.                          QBFBSTAT will append an extension for you.
  97.  
  98.         
  99.  
  100.     3.  An Editor that will create text files, such as EDLIN, GALAXY,
  101.         or any Editor that will allow CR/LF combinations at the end of each
  102.         line has to be used.  Create the QBFBStat.Ctl file in your QuickBBS
  103.         System directory with the following information:
  104.  
  105.  
  106.  
  107.         b.  The QBFBSTAT.CTL File:
  108.  
  109.         The QBFBStat.CTL file uses KEYWORDS to control how your File
  110.         Areas Statistics are to be created.  The KEYWORDS require also
  111.         one or more arguments to be used with it.  The KEYWORDS may
  112.         appear in upper or lower case or mixed.
  113.  
  114.         1)  PATH    -  This KEYWORD is used to define the path and
  115.                        bulletin name you want to create.
  116.  
  117.              Example:
  118.                 PATH C:\QuickBBS\TXTFILES\FILESTAT
  119.  
  120.         2)  TITLE   -  This Keyword is used to define the title you
  121.                        wish to have in the bulletin.  Maximum length
  122.                        for the title is 70 characters.
  123.  
  124.              Example:
  125.                 TITLE Anyname BBS - Anytown, USA
  126.  
  127.         3)   COLOR0  - The color you want the top and bottom lines of the
  128.                        bulletin to be.
  129.  
  130.         4)   COLOR1  - The color you want the title to be.
  131.  
  132.         5)   COLOR2  - The color you want the Last update statement to be.
  133.  
  134.         6)   COLOR3  - The color you want the last update DATE to be.
  135.  
  136.         7)   COLOR4  - The color you want the file areas summary 
  137.                        statement to be.
  138.  
  139.         8)   COLOR5  - The color you want the file areas summary
  140.                        DATA to be.
  141.  
  142.         9)   COLOR6 -  The color you want the File Areas, Files, Bytes,
  143.                        Percent heading to be.
  144.  
  145.         10)  COLOR7 -  The color you want the Area Names to be.
  146.  
  147.         11)  COLOR8 -  The color you want the File Area total files
  148.                        column to be.
  149.  
  150.         12)  COLOR9 -  The color you want the total bytes column of each
  151.                        File Area to be.
  152.  
  153.         13)  COLOR10 - The color you want the File Areas Percent column
  154.                        to be.
  155.  
  156.         14)  BACKGROUND - The color you want the background of the
  157.                           bulletin to be.
  158.  
  159.              Example:
  160.  
  161.                Color0  15
  162.                Color1  14
  163.                Color2  14
  164.                Color3  2
  165.                Color4  15
  166.                Color5  2
  167.                Color6  10
  168.                Color7  14
  169.                Color8  10
  170.                Color9  5
  171.                Color10 13
  172.                Background 0
  173.  
  174.         
  175.         15)  DOWNLOADSEC  - Use this KEYWORD if you want the DOWNLOAD
  176.                             SECURITY level to be checked for each file
  177.                             area.  If this KEYWORD is ommitted, then
  178.                             the download security level will not be
  179.                             checked.  Maximum download security level
  180.                             is 64000.
  181.  
  182.              Example:
  183.                 DownloadSec 5
  184.  
  185.         16)  SEARCHSEC    - Use this KEYWORD if you want the SEARCH
  186.                             SECURITY level to be checked for each file
  187.                             area.  If this KEYWORD is ommitted, then
  188.                             the list security level will not be checked.
  189.                             Maximum Search security level is 64000.
  190.  
  191.              Example:
  192.                 SearchSec 5
  193.  
  194.         17)  TEMPLATESEC  - Use this KEYWORD if you want the TEMPLATE
  195.                             SECURITY level to be checked for each file
  196.                             area.  If this KEYWORD is ommitted, then
  197.                             the template security level will not be 
  198.                             checked.  Maximum template security level is
  199.                             64000.
  200.  
  201.              Example:
  202.                 TemplateSec 5
  203.  
  204.  
  205.         Note:  The follwing flags correspond to the A,B,C,D flag settings
  206.                that you have set in each File Area.
  207.  
  208.         18)  DOWNLOADSECFLAGS  - Use this KEYWORD if you want the DOWNLOAD
  209.                                  SECURITY flags to be checked for each
  210.                                  file area.  If this keyword is ommitted,
  211.                                  the the download security flags will not
  212.                                  be checked.
  213.  
  214.              Example:
  215.                 DownloadSecFlags X------- X------- X------- X-------
  216.  
  217.  
  218.         19)  SEARCHSECFLAGS   -  Use this KEYWORD if you want the SEARCH
  219.                                  SECURITY flags to be checked for each
  220.                                  file area.  If this keyword is ommitted,
  221.                                  the search security flags will not be
  222.                                  checked.
  223.  
  224.              Example:
  225.                 SearchSecFlags X------- X------- X------- X-------           
  226.  
  227.         20)  TEMPLATESECFLAGS -  Use this KEYWORD if you want the TEMPLATE
  228.                                  SECURITY flags to be checked for each
  229.                                  file area.  If this keyword is ommitted,
  230.                                  the template security flags will not be
  231.                                  checked.
  232.  
  233.              Example:
  234.                 TemplateSecFlags X------- X------ X------ X------
  235.  
  236.  
  237.         21)  FILESPECS  - Use this KEYWORD to tell QBFBSTAT what files
  238.                           to include in the bulletin.  Up to 30 FileSpec
  239.                           arguments mat be given.
  240.  
  241.              Example:
  242.                 FileSpecs *.ZIP *.ARC NODEDIFF.A??
  243.                 
  244.  
  245.     c.  How to run QBFBStat:
  246.  
  247.         1) Usage:  QBFBStat [-?] [<-F Path>]
  248.  
  249.             -F Path   - Using this argument will allow you to specify
  250.                         a different path for the .CTL file other than
  251.                         the default QBFBSTAT.CTL.  This option is only
  252.                         available to registered copies of QBFBStat.
  253.  
  254.  
  255.             QBFBStat.Exe need not exist in the QuickBBS System directory to
  256.             generate the bulletin(s).   The -F option allows you to
  257.             execute QBFBStat from anywhere on your system.  By default
  258.             QBFBStat will search the currently accessed directory for
  259.             the QBFBStat.CTL file.  
  260.  
  261.     -----------------------------*-----------------------------
  262.  
  263. 6.  Problem(s) History:
  264.  
  265.      11/29/91 - First Release.
  266.      v1.0
  267.  
  268.      ----------------------------*-----------------------------
  269.  
  270. Other Quality Software Products from Foxtrot Software are:
  271.  
  272. Magic name    Description
  273.  
  274. RaTop         Top Users bulletin maker for RemoteAccess 1.1.
  275.  
  276. QuikTop       Top Users bulletin maker for QuickBBS 2.75+            
  277.                    
  278. OpusTop       Top Users bulletin maker for OPUS CBCS 1.1x.
  279.  
  280. RaFbStat      File Area Statistics bulletin generator for QuickBBS 2.75+
  281.  
  282. Coming Soon:
  283.  
  284.     Magic name
  285.  
  286.     SuperTop     - Top Users bulletin maker for SuperBBS bulletin boards.
  287.     
  288.     
  289. PROBLEMS:
  290.  
  291.    Please notify me immediately if you have any problems or
  292. suggestions about this program.  Enhancements are being incorporated
  293. all the time and your input is more vital to this process than you
  294. think.  You may write me, send Net-Mail or logon at the following address:
  295.  
  296. For Registration or reports:
  297.  
  298. Foxtrot Software        
  299. c/o Byron Copeland                   Info-Center BBS
  300. 11 Y Street                          (914) 567-1814 @Fidonet 1:272/26
  301. New Windsor, Ny.                     24 hours a day!
  302. 12553
  303.  
  304.  
  305.  
  306.                   Enjoy and thank you for your support!
  307.  
  308.  
  309.                                - End -
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.  
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334.  
  335.  
  336.  
  337.  
  338.  
  339.  
  340.  
  341.  
  342.  
  343.  
  344.  
  345.  
  346.  
  347.  
  348. 
  349.